1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
use crate::decl::*;
use crate::gui::{*, iterators::*};
use crate::msg::*;
use crate::prelude::*;
/// Exposes item methods of a [`ListBox`](crate::gui::ListBox) control.
///
/// You cannot directly instantiate this object, it is created internally by the
/// control.
pub struct ListBoxItems<'a> {
owner: &'a ListBox,
}
impl<'a> ListBoxItems<'a> {
#[must_use]
pub(in crate::gui) const fn new(owner: &'a ListBox) -> Self {
Self { owner }
}
/// Adds new texts by sending [`lb::AddString`](crate::msg::lb::AddString)
/// messages.
///
/// # Examples
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, gui};
///
/// let my_list: gui::ListBox; // initialized somewhere
/// # let wnd = gui::WindowMain::new(gui::WindowMainOpts::default());
/// # let my_list = gui::ListBox::new(&wnd, gui::ListBoxOpts::default());
///
/// my_list.items().add(&["John", "Mary"]);
/// ```
pub fn add(&self, items: &[impl AsRef<str>]) {
for text in items.iter() {
unsafe {
self.owner.hwnd()
.SendMessage(lb::AddString {
text: WString::from_str(text.as_ref()),
})
}.unwrap();
}
}
/// Retrieves the number of items by sending an
/// [`lb::GetCount`](crate::msg::lb::GetCount) message.
#[must_use]
pub fn count(&self) -> u32 {
unsafe {
self.owner.hwnd()
.SendMessage(lb::GetCount {})
}.unwrap()
}
/// Deletes the item at the given index by sending an
/// [`lb::DeleteString`](crate::msg::lb::DeleteString) message.
pub fn delete(&self, index: u32) {
unsafe {
self.owner.hwnd()
.SendMessage(lb::DeleteString { index })
}.unwrap();
}
/// Deletes all items by sending an
/// [`lb::ResetContent`](crate::msg::lb::ResetContent) message.
pub fn delete_all(&self) {
unsafe { self.owner.hwnd().SendMessage(lb::ResetContent {}); }
}
/// Ensures that the specified item in a list box is visible by sending an
/// [`lb::SetTopIndex`](crate::msg::lb::SetTopIndex) message.
pub fn ensure_visible(&self, index: u32) {
unsafe {
self.owner.hwnd()
.SendMessage(lb::SetTopIndex { index })
}.unwrap();
}
/// Returns an iterator over the texts.
///
/// # Examples
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, gui};
///
/// let my_list: gui::ListBox; // initialized somewhere
/// # let wnd = gui::WindowMain::new(gui::WindowMainOpts::default());
/// # let my_list = gui::ListBox::new(&wnd, gui::ListBoxOpts::default());
///
/// for text in my_list.items().iter() {
/// println!("Text {}", text);
/// }
/// ```
#[must_use]
pub fn iter(&self) -> impl Iterator<Item = String> + 'a {
ListBoxItemIter::new(self.owner)
}
/// Returns an iterator over the currently selected texts.
///
/// This method works for both single and multiple-selection lists.
///
/// # Examples
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, gui};
///
/// let my_list: gui::ListBox; // initialized somewhere
/// # let wnd = gui::WindowMain::new(gui::WindowMainOpts::default());
/// # let my_list = gui::ListBox::new(&wnd, gui::ListBoxOpts::default());
///
/// for (sel_idx, text) in my_list.items().iter_selected() {
/// println!("Text {}: {}", sel_idx, text);
/// }
/// ```
#[must_use]
pub fn iter_selected(&self) -> impl Iterator<Item = (u32, String)> + 'a {
ListBoxSelItemIter::new(self.owner)
}
/// Retrieves the number of selected items by sending an
/// [`lb::GetSelCount`](crate::msg::lb::GetSelCount) message.
#[must_use]
pub fn selected_count(&self) -> u32 {
unsafe {
self.owner.hwnd()
.SendMessage(lb::GetSelCount {})
}.unwrap()
}
/// Retrieves the text at the given position, if any, by sending a
/// [`lb::GetText`](crate::msg::lb::GetText) message.
#[must_use]
pub fn text(&self, index: u32) -> String {
let num_chars = unsafe {
self.owner.hwnd()
.SendMessage(lb::GetTextLen { index })
}.unwrap();
let mut buf = WString::new_alloc_buf(num_chars as usize + 1);
unsafe {
self.owner.hwnd()
.SendMessage(lb::GetText { index, text: &mut buf })
}.unwrap();
buf.to_string()
}
}